# List invitations for a group

Returns a paginated list of invitations for the specified group, optionally filtered by status. Requires the GroupMembers.Invite RBAC permission (group admin/owner). Authentication is required.

RBAC: requires GroupMembers.Invite

Endpoint: GET /api/v1/groups/{groupId}/invites
Version: 1.0
Security: header

## Query parameters:

  - `lastId` (string,null)
    Get older records (records with IDs less than this value) Alias maxId/max_id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `limit` (integer,null)

  - `offset` (integer,null)

  - `sortBy` (string,null)

  - `sortOrder` (string,null)
    Sort order. Supported values: ASC or DESC

  - `status` (string,null)
    Filters invitations by status. If omitted, returns all.
    Enum: "PENDING", "ACCEPTED", "REJECTED"

  - `untilId` (string,null)
    Get newer records (records with IDs greater than this value) Alias minId/min_id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

## Path parameters:

  - `groupId` (string, required)
    The unique identifier of the group
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

## Response 200 fields (application/json):

  - `groupInviteId` (string, required)
    Unique identifier for this invitation
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `groupId` (string, required)
    ID of the group
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviterId` (string, required)
    ID of the user who sent the invitation
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviteeId` (string,null)
    ID of the user being invited (null for email-only invites)
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `status` (string, required)
    Current status of the invitation
    Enum: "PENDING", "ACCEPTED", "REJECTED"

  - `message` (string,null)
    Optional message from the inviter

  - `email` (string,null)
    Email address of the invitee (present for email-based invites)

  - `inviterName` (string, required)
    Username of the inviter

  - `inviterDisplayName` (string, required)
    Display name of the inviter

  - `inviterAvatar` (object,null)
    Avatar of the inviter

  - `inviterAvatar.uploadId` (string, required)
    Internal id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviterAvatar.uploaderId` (string,null)
    User who physically uploaded this file. Null for platform-owned uploads (e.g., default covers). This is an audit/meta field — use ownerId for authorization.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviterAvatar.ownerId` (string, required)
    Entity that owns this upload (user, channel/group, or event). TypeID prefix indicates the owner type.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviterAvatar.attachedToId` (string,null)
    Entity this upload is attached to (e.g., a post or event). NULL for standalone uploads like avatars, covers, or media library items.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviterAvatar.uploadType` (string, required)
    Type of the upload
    Enum: "VIDEO", "IMAGE", "AUDIO", "DOCUMENT", "OTHER"

  - `inviterAvatar.meta` (object)
    Meta data

  - `inviterAvatar.meta.blurhash` (string,null)

  - `inviterAvatar.meta.name` (string,null)

  - `inviterAvatar.meta.altText` (string,null)

  - `inviterAvatar.size` (integer, required)
    Size in bytes of all the files in this upload

  - `inviterAvatar.files` (array, required)
    List of all the files this upload has

  - `inviterAvatar.files.uri` (string,null, required)
    Full url of the file

  - `inviterAvatar.files.fileId` (string, required)
    File id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviterAvatar.files.extension` (string, required)
    File extension
    Example: "mp4"

  - `inviterAvatar.files.original` (boolean, required)
    true if this file is original, false if it is a derivative

  - `inviterAvatar.files.meta` (object, required)
    File metadata. Contains optional values for width, height etc.

  - `inviterAvatar.files.meta.duration` (number,null)
    Video duration in seconds

  - `inviterAvatar.files.meta.width` (integer,null)
    Media width

  - `inviterAvatar.files.meta.height` (integer,null)
    Media height

  - `inviterAvatar.files.meta.codec` (string,null)
    Video codec

  - `inviterAvatar.files.meta.rotate` (integer,null)
    Rotation in degrees

  - `inviterAvatar.files.size` (integer, required)
    File size in bytes

  - `inviterAvatar.files.createdAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `inviterAvatar.files.updatedAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `inviterAvatar.files.type` (string, required)
    File type
    Enum: "VIDEO", "IMAGE", "AUDIO", "DOCUMENT", "OTHER"

  - `inviterAvatar.tags` (array, required)
    List of tags attached to upload
    Enum: "Post", "Avatar", "Header", "Album", "Emoji", "Event"

  - `inviterAvatar.error` (string,null)
    Upload processing error

  - `inviterAvatar.cached` (boolean)
    true if cached

  - `inviterAvatar.logs` (string,null)
    Logs

  - `inviterAvatar.remote` (boolean)
    true if this upload is remote

  - `inviterAvatar.createdAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `inviterAvatar.updatedAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `inviteeName` (string,null)
    Username of the invitee (null for unclaimed email-only invites)

  - `inviteeDisplayName` (string,null)
    Display name of the invitee (null for unclaimed email-only invites)

  - `inviteeAvatar` (object,null)
    Avatar of the invitee

  - `inviteeAvatar.uploadId` (string, required)
    Internal id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviteeAvatar.uploaderId` (string,null)
    User who physically uploaded this file. Null for platform-owned uploads (e.g., default covers). This is an audit/meta field — use ownerId for authorization.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviteeAvatar.ownerId` (string, required)
    Entity that owns this upload (user, channel/group, or event). TypeID prefix indicates the owner type.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviteeAvatar.attachedToId` (string,null)
    Entity this upload is attached to (e.g., a post or event). NULL for standalone uploads like avatars, covers, or media library items.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviteeAvatar.uploadType` (string, required)
    Type of the upload
    Enum: "VIDEO", "IMAGE", "AUDIO", "DOCUMENT", "OTHER"

  - `inviteeAvatar.meta` (object)
    Meta data

  - `inviteeAvatar.meta.blurhash` (string,null)

  - `inviteeAvatar.meta.name` (string,null)

  - `inviteeAvatar.meta.altText` (string,null)

  - `inviteeAvatar.size` (integer, required)
    Size in bytes of all the files in this upload

  - `inviteeAvatar.files` (array, required)
    List of all the files this upload has

  - `inviteeAvatar.files.uri` (string,null, required)
    Full url of the file

  - `inviteeAvatar.files.fileId` (string, required)
    File id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `inviteeAvatar.files.extension` (string, required)
    File extension
    Example: "mp4"

  - `inviteeAvatar.files.original` (boolean, required)
    true if this file is original, false if it is a derivative

  - `inviteeAvatar.files.meta` (object, required)
    File metadata. Contains optional values for width, height etc.

  - `inviteeAvatar.files.meta.duration` (number,null)
    Video duration in seconds

  - `inviteeAvatar.files.meta.width` (integer,null)
    Media width

  - `inviteeAvatar.files.meta.height` (integer,null)
    Media height

  - `inviteeAvatar.files.meta.codec` (string,null)
    Video codec

  - `inviteeAvatar.files.meta.rotate` (integer,null)
    Rotation in degrees

  - `inviteeAvatar.files.size` (integer, required)
    File size in bytes

  - `inviteeAvatar.files.createdAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `inviteeAvatar.files.updatedAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `inviteeAvatar.files.type` (string, required)
    File type
    Enum: "VIDEO", "IMAGE", "AUDIO", "DOCUMENT", "OTHER"

  - `inviteeAvatar.tags` (array, required)
    List of tags attached to upload
    Enum: "Post", "Avatar", "Header", "Album", "Emoji", "Event"

  - `inviteeAvatar.error` (string,null)
    Upload processing error

  - `inviteeAvatar.cached` (boolean)
    true if cached

  - `inviteeAvatar.logs` (string,null)
    Logs

  - `inviteeAvatar.remote` (boolean)
    true if this upload is remote

  - `inviteeAvatar.createdAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `inviteeAvatar.updatedAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `groupName` (string, required)
    Name of the group

  - `groupDisplayName` (string, required)
    Display name of the group

  - `groupAvatar` (object,null)
    Avatar of the group

  - `groupAvatar.uploadId` (string, required)
    Internal id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `groupAvatar.uploaderId` (string,null)
    User who physically uploaded this file. Null for platform-owned uploads (e.g., default covers). This is an audit/meta field — use ownerId for authorization.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `groupAvatar.ownerId` (string, required)
    Entity that owns this upload (user, channel/group, or event). TypeID prefix indicates the owner type.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `groupAvatar.attachedToId` (string,null)
    Entity this upload is attached to (e.g., a post or event). NULL for standalone uploads like avatars, covers, or media library items.
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `groupAvatar.uploadType` (string, required)
    Type of the upload
    Enum: "VIDEO", "IMAGE", "AUDIO", "DOCUMENT", "OTHER"

  - `groupAvatar.meta` (object)
    Meta data

  - `groupAvatar.meta.blurhash` (string,null)

  - `groupAvatar.meta.name` (string,null)

  - `groupAvatar.meta.altText` (string,null)

  - `groupAvatar.size` (integer, required)
    Size in bytes of all the files in this upload

  - `groupAvatar.files` (array, required)
    List of all the files this upload has

  - `groupAvatar.files.uri` (string,null, required)
    Full url of the file

  - `groupAvatar.files.fileId` (string, required)
    File id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `groupAvatar.files.extension` (string, required)
    File extension
    Example: "mp4"

  - `groupAvatar.files.original` (boolean, required)
    true if this file is original, false if it is a derivative

  - `groupAvatar.files.meta` (object, required)
    File metadata. Contains optional values for width, height etc.

  - `groupAvatar.files.meta.duration` (number,null)
    Video duration in seconds

  - `groupAvatar.files.meta.width` (integer,null)
    Media width

  - `groupAvatar.files.meta.height` (integer,null)
    Media height

  - `groupAvatar.files.meta.codec` (string,null)
    Video codec

  - `groupAvatar.files.meta.rotate` (integer,null)
    Rotation in degrees

  - `groupAvatar.files.size` (integer, required)
    File size in bytes

  - `groupAvatar.files.createdAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `groupAvatar.files.updatedAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `groupAvatar.files.type` (string, required)
    File type
    Enum: "VIDEO", "IMAGE", "AUDIO", "DOCUMENT", "OTHER"

  - `groupAvatar.tags` (array, required)
    List of tags attached to upload
    Enum: "Post", "Avatar", "Header", "Album", "Emoji", "Event"

  - `groupAvatar.error` (string,null)
    Upload processing error

  - `groupAvatar.cached` (boolean)
    true if cached

  - `groupAvatar.logs` (string,null)
    Logs

  - `groupAvatar.remote` (boolean)
    true if this upload is remote

  - `groupAvatar.createdAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `groupAvatar.updatedAt` (string, required)
    Example: "2022-03-10T16:15:50Z"

  - `createdAt` (string, required)
    When the invitation was created
    Example: "2022-03-10T16:15:50Z"

  - `updatedAt` (string, required)
    When the invitation was last updated
    Example: "2022-03-10T16:15:50Z"

## Response 401 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation

## Response 403 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation

## Response 404 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation


